Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SF-3202 Add IsDraftingEnabled flag to Projects API #3002

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pmachapman
Copy link
Collaborator

@pmachapman pmachapman commented Feb 11, 2025

This PR adds an additional property to the /paratext-api/projects endpoint to express whether a project has drafting enabled or not.

This will make it easier for the Paratext Extension to determine what projects can be connected to that already have pre-translation drafting enabled.

This PR is marked as testing not required, as it is an API endpoint change, and so can be tested by a developer as it does not change user experience.


This change is Reviewable

@pmachapman pmachapman changed the title Add IsDraftingEnabled flag to Projects API SF-3202 Add IsDraftingEnabled flag to Projects API Feb 11, 2025
Copy link

codecov bot commented Feb 11, 2025

Codecov Report

Attention: Patch coverage is 96.55172% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.54%. Comparing base (454b323) to head (9ef2138).

Files with missing lines Patch % Lines
...c/SIL.XForge.Scripture/Services/ParatextService.cs 96.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3002   +/-   ##
=======================================
  Coverage   82.53%   82.54%           
=======================================
  Files         551      551           
  Lines       31974    31984   +10     
  Branches     5182     5185    +3     
=======================================
+ Hits        26390    26401   +11     
- Misses       4815     4826   +11     
+ Partials      769      757   -12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pmachapman pmachapman marked this pull request as ready for review February 11, 2025 02:03
@Nateowami
Copy link
Collaborator

@pmachapman Might it be more useful to indicate if a project has a draft, than whether it's enabled? Or maybe we should have both?

@pmachapman
Copy link
Collaborator Author

Or maybe we should have both?

This is a great idea. I will mark this as draft until I add that!

@pmachapman pmachapman changed the title SF-3202 Add IsDraftingEnabled flag to Projects API WIP: SF-3202 Add IsDraftingEnabled flag to Projects API Feb 11, 2025
@pmachapman pmachapman marked this pull request as draft February 11, 2025 18:47
@pmachapman pmachapman changed the title WIP: SF-3202 Add IsDraftingEnabled flag to Projects API SF-3202 Add IsDraftingEnabled flag to Projects API Feb 11, 2025
@pmachapman pmachapman marked this pull request as ready for review February 11, 2025 20:52
Copy link
Collaborator

@Nateowami Nateowami left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 3 files at r1.
Reviewable status: 1 of 3 files reviewed, 1 unresolved discussion


src/SIL.XForge.Scripture/Models/ParatextProject.cs line 94 at r1 (raw file):

                IsConnectable.ToString(),
                IsConnected.ToString(),
                IsDraftingEnabled.ToString(),

Missing HasDraft

Copy link
Collaborator Author

@pmachapman pmachapman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 1 of 3 files reviewed, all discussions resolved (waiting on @Nateowami)


src/SIL.XForge.Scripture/Models/ParatextProject.cs line 94 at r1 (raw file):

Previously, Nateowami wrote…

Missing HasDraft

Done. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants